Drop phony requirement on README_TEMPLATE_FILE
#379
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
osterman
requested review from
Nuru
and removed request for
goruha and
aknysh
Nuru
requested changes
Feb 9, 2024
There was a problem hiding this comment.
- The breakage cited is not due to local templates being overwritten, it is due to parsing README.md rather than README.yaml
- We have no other mechanism for ensuring that the README template gets updated when changed at the source
I am not saying we do not need to change anything, only that this is not the way to fix anything. I will propose a solution once I better understand the full extent of the problem.
|
Templates are not proberly ending in https://github.com/cloudposse/docs/tree/master/scripts/docs-collator/templates They are rendered here: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
what
.PHONYforREADME_TEMPLATE_FILEwhy
make readmein lots of other places where we generate READMEs based on local templates that differ from the org template. Here are 2 examples.references
README.md.gotmpl#368